Repository navigation
docs: convert index.rst to MyST .md - #294
Merged
Merged
Conversation
Converts docs/index.rst to docs/index.md and adds `myst_parser` to the Sphinx extensions list (the docs were RST-only previously). The single index page is a thin wrapper around the README. Part of PyAutoLabs/PyAutoFit#1245. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Branch caught up to
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Converts the single prose page (
docs/index.rst, a thin wrapper around the project README) to MyST Markdown for consistency with the conversion across the other PyAuto libraries. Addsmyst_parserto the Sphinxextensionslist — it wasn't previously configured because the docs were RST-only.Part of PyAutoLabs/PyAutoFit#1245.
API Changes
None — internal docs only.
Test Plan
sphinx-build -b html docs docs/_build/htmlruns cleanlyFull API Changes (for automation & release notes)
None — this PR only changes documentation source files.
🤖 Generated with Claude Code